Skip to main content
GET
/
api
/
v1
/
bills
/
records
Transaction History
curl --request GET \
  --url https://api.dev.monei.cc/api/v1/bills/records \
  --header 'X-API-KEY: <api-key>'
{
  "statusCode": 123,
  "message": "<string>",
  "data": {
    "bills": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedDate": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "reference": "<string>",
        "billerCode": "<string>",
        "itemCode": "<string>",
        "customer": "<string>",
        "amount": 123,
        "providerData": "<string>",
        "txRef": "<string>",
        "billerName": "<string>",
        "validityPeriod": "<string>",
        "metadata": "<string>",
        "token": "<string>",
        "units": "<string>"
      }
    ],
    "page": 1,
    "limit": 10,
    "total": 100,
    "totalPages": 10,
    "hasNext": true,
    "hasPrev": false
  },
  "errors": {}
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
type
enum<string>

Filter by transaction type

Available options:
AIRTIME,
MOBILEDATA,
CABLEBILLS,
UTILITYBILLS
Example:

"AIRTIME"

​
status
enum<string>

Filter by transaction status

Available options:
PENDING,
SUCCESS,
FAILED
Example:

"SUCCESS"

​
billerName
string

Filter by biller name (partial match)

Example:

"MTN"

​
billerCode
string

Filter by biller code

Example:

"BIL099"

​
customer
string

Filter by customer reference/phone number

Example:

"08012345678"

​
startDate
string

Start date for filtering (YYYY-MM-DD)

Example:

"2024-01-01"

​
endDate
string

End date for filtering (YYYY-MM-DD)

Example:

"2024-12-31"

​
search
string

Search in reference or txRef fields

Example:

"REF12345"

​
minAmount
number

Minimum amount filter

Example:

100

​
maxAmount
number

Maximum amount filter

Example:

1000

​
page
number
default:1

Page number (starting from 1)

Example:

1

​
limit
number
default:10

Number of items per page

Example:

10

​
sortBy
string
default:createdAt

Sort field

Example:

"createdAt"

​
sortOrder
enum<string>
default:DESC

Sort order

Available options:
ASC,
DESC
Example:

"DESC"

Response

200 - application/json
​
statusCode
number
required
​
message
string
required
​
data
object
required

Bill payment transaction history

​
errors
object
required